2.5 批量修改本地用户

基本信息

Path: /api/v2/localUser/batchUpdateUser

Method: POST

接口描述:

  1. 对于更新接口中的非必须参数,如果不传,不会对该条数据相对应参数进行修改
  2. 认证策略ID,authComposeId获取方式,用“开发者工具”过滤请求 authCompose/queryAll,在控制台“业务管理”->“认证管理”->“认证策略”页面中打开您新增用户所属的用户目录,找到所属用户目录的认证策略查询接口,查看响应体数据获取对应的认证策略ID
  3. 用户策略ID,userPolicyId获取方式,用“开发者工具”过滤请求 userPolicy/queryUserPolicy,进入控制台“业务管理”->“策略管理”->“用户策略”页面,查看响应体数据获取所需策略的ID
  4. 对于参数password,为了保障数据传输过程中(数据从浏览器/客户端到服务端的过程)密码数据的安全,强烈建议使用RSA算法对密码字段进行加密(将pwdModel参数设置为'rsa')。加密方式参考《使用说明文档》附录。如果您不想对密码字段进行加密(不建议),可以不传pwdModel参数或者将pwdModel参数设置为'clear'。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 必须  

Body

名称 类型 是否必须 默认值 备注 其他信息
idList string[] 与nameList、externalIdList三选一 本地用户ID列表 idList与nameList、externalIdList只传一个即可,都传时以idList为准
nameList string[] 与idList、externalIdList三选一 本地用户名字列表 idList与nameList、externalIdList只传一个即可,都传时以idList为准
externalIdList string[] 与idList、nameList三选一 本地用户外部ID列表(2.5.10开始支持) idList与nameList、externalIdList只传一个即可,都传时以
value object 必须 修改内容对象
├─ description string 非必须 描述
├─ password string 非必须 密码 如果使用'rsa'密码模式,需要对密码进行加密
├─ pwdModel string 非必须 'clear' 密码加密算法类型:'clear'明文,'rsa'非对称加密 强烈建议使用'rsa'
├─ expiredTime string 非必须 过期时间,13位长度的Unix时间戳,'0'表示永不过期
├─ status number 非必须 启用状态:0禁用,1启用
├─ groupId string 非必须 所属组ID 根组ID为'root'
├─ inheritGroup number 非必须 继承所属组的应用授权:0不继承,1继承
├─ resourceEditWay string 非必须 'reset' 编辑方式'reset', 'append'
├─ resourceList object[] 非必须 应用ID,与 resourceIdList/resourceNameList 任选其一,都传时以 resourceList 为主 <2.2.16: 低版本使用此方式传递应用数组
├─├─ id string 非必须 应用ID <2.2.16: 低版本使用此方式传递应用数组
├─ resourceIdList string[] 非必须 应用ID,与 resourceList/resourceNameList 任选其一,都传时以 resourceList 为主 >=2.2.16: 高版本使用此方式传递应用数组
├─ resourceNameList string[] 非必须 应用名,与 resourceList/resourceIdList 任选其一,都传时以 resourceList 为主 >=2.2.16: 高版本使用此方式传递应用数组
├─ resourceGroupIdList string[] 非必须 应用组ID数组,与resourceGroupNameList二选一,都传时以resourceGroupIdList为主
├─ resourceGroupNameList string[] 非必须 应用组名数组,与resourceGroupIdList二选一,都传时以resourceGroupIdList为主 >=2.2.16: 支持使用此方式传递应用数组
├─ roleEditWay string 非必须 'reset' 角色编辑方式'reset', 'append'
├─ roleIdList string[] 非必须 角色ID数组 roleIdList和roleNameList只传一个即可,都传时以roleIdList为准
├─ roleNameList string[] 非必须 角色名列表 roleIdList和roleNameList只传一个即可,都传时以roleIdList为准
├─ authComposeId string 非必须 认证策略ID,名称与ID只需要传一个即可,都传时以ID为准 "1" 表示默认策略
>=2.2.5:可以传空字符串代表策略为空
<2.2.5:不支持传空字符串
├─ authComposeName string 非必须 认证策略名称,名称与ID只需要传一个即可,都传时以ID为准 >=2.2.16:支持此参数
<2.2.16:不支持此参数
├─ userPolicyId string 非必须 用户策略ID,名称与ID只需要传一个即可,都传时以ID为准 "default" 表示默认策略
>=2.2.5:可以传空字符串代表策略为空
<2.2.5:不支持传空字符串
├─ userPolicyName string 非必须 用户策略名称,名称与ID只需要传一个即可,都传时以ID为准 >=2.2.16:支持此参数
<2.2.16:不支持此参数

请求示例

{
  "idList": [
    "04bac940-fbf9-11ea-9906-116c10ccbb30",
    "e1ded190-5964-11eb-a9a0-931833117fac"
  ],
  "value": {
    "description": "",
        "password": "22033431e0eb565d3fdbfa9b4f124798cbbd48bb9ab34c4bb9d97bce7d12a8c218b0ad677e3d6de5162fad14245e942755b3db3ae822a9e49fa633498382a720a41b11a7fafe13bc09225444983f3974ede2824f6b195186ef32d8184fbf2af67c3f7a3dbcabc89c3d560d6f4044a8f15d3acec043d6c7fccba3681f44da239451a2eba0701121839cf6c771b3e67b5c9a8174bc9b117aba74aea0c3b8e736c1976751153a38826f3af80169586530fa3ee2f414aed46ec0c6f8ac90deed08203fe22e09123f5fcfce9eeb58ced1f92715e7b003e19142eaa0f97cded5f2a97cb3c0aee6585a62db60977d9af60f7d7d2e0d021fca704fc0b4076c39297c3ea9",
        "pwdModel": "rsa",
        "expiredTime": "0",
        "status": 1,
        "groupId": "root",
        "inheritGroup": 1,
    "resourceEditWay": "append",
    "resourceIdList": [
      "ac7ecd60-bec8-11eb-9b83-519633ac8d70"
    ],
    "resourceGroupIdList": [],
    "roleIdEditWay": "append",
    "roleIdList": [
      "7759f620-5583-11eb-880a-913383f106f2",
      "6559f620-5583-11eb-880a-913383f106f2"
    ],
    "authComposeId": "fbda378b-fa23-4e8b-b4a7-cf7f979cd85b",
    "userPolicyId": "88040d85-0e58-432c-8568-4c5a8e1907ef"
  }
}

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 错误码,非0表示错误,具体含义请参考错误码定义
data object 必须 返回内容
msg string 必须 描述信息  

返回示例

{
    "code": 0,
    "data": {},
    "msg": "请求成功"
}

错误信息

错误提示 错误码
请输入本地用户名称数组或本地用户ID数组 7201
用户状态只能是启用或者禁用 7201
用户最多关联2000个角色 10000000
密码不能属于常见弱密码 10000001
密码不能包含特殊关键字%s 10000001
密码不能包含用户名 10000000
数据不存在或已经被删除 77200004
批量编辑操作数量已经超过上限:10000 10000000
组织架构不存在 10000001
认证策略不存在 77200005
用户策略不存在 77200005
用户名不允许被编辑 77200005
保存失败,关联的应用集不存在 77200004
保存失败,关联的应用不存在或已被删除 77200004
保存失败,关联的应用分类不存在或已被删除 77200004
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-10-19 11:07

results matching ""

    No results matching ""